<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Synan: ISentence Interface Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.4 -->
<div class="qindex"><a class="qindex" href="index.html">Main&nbsp;Page</a> | <a class="qindex" href="annotated.html">Class&nbsp;List</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="functions.html">Class&nbsp;Members</a> | <a class="qindex" href="examples.html">Examples</a></div>
<h1>ISentence Interface Reference</h1><!-- doxytag: class="ISentence" --><code>import &quot;<a class="el" href="SynAn_8idl-source.html">SynAn.idl</a>&quot;;</code>
<p>
<a href="classISentence-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a0">PrimitiveClausesCount</a> ([out, retval] long *pVal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a1">PrimitiveClause</a> ([in] long lClauseNum,[out, retval] <a class="el" href="classIClause.html">IClause</a> **pVal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a2">WordsNum</a> ([out, retval] long *pVal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a3">Word</a> ([in] long lWordNum,[out, retval] <a class="el" href="classIWord.html">IWord</a> **pVal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a4">ClausesCount</a> ([out, retval] long *pVal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a5">Clause</a> ([in]long lClauseNum,[out, retval] <a class="el" href="classIClause.html">IClause</a> **pVal)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a6">CreateRelationsIterator</a> ([out, retval] <a class="el" href="interfaceIRelationsIterator.html">IRelationsIterator</a> **piRelsIt)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a7">GetHomonymByClauseVar</a> ([in]long iWord,[in]long iVar,[in]long iClause,[out, retval]<a class="el" href="classIHomonym.html">IHomonym</a> **piHom)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a8">ClauseNoByPrimitiveClauseNo</a> ([in]long lPrClauseNo,[out, retval]long *lClauseNo)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a9">PrimitiveClauseNoByClauseNo</a> ([in]long lClauseNo,[out, retval]long *lPrClauseNo)</td></tr>

<tr><td class="memItemLeft" nowrap align="right" valign="top">HRESULT&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classISentence.html#a10">GetOborotStrByOborotId</a> ([in] long OborotId,[out, retval] BSTR *pVal)</td></tr>

</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
A sentence provides an access to one input sentence. A sentence contains a vector of words and a set of clauses. A clause can be called a primitive or minimal one, if there is a word for which this clause is the smallest clause, which contains this word. In principle, it is possible to create a clause, which contains a one or more subclauses and and which does not immediately contain words. The interface supports two lists of clauses: the full list(slots ClausesCount and   Clause) and the list of primitive clauses. There is a special function ("PrimitiveClauseNoByClauseNo") which returns an index in the full list by an index of primitive clauses. The interface also provides an access to <a class="el" href="interfaceIRelationsIterator.html">IRelationsIterator</a>, which contains a dependency forest for this sentence.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="a5"></a><!-- doxytag: member="ISentence::Clause" ref="a5" args="([in]long lClauseNum,[out, retval] IClause **pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::Clause           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>lClauseNum</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] <a class="el" href="classIClause.html">IClause</a> **&nbsp;</td>
          <td class="mdname" nowrap> <em>pVal</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
a clause by an index     </td>
  </tr>
</table>
<a class="anchor" name="a8"></a><!-- doxytag: member="ISentence::ClauseNoByPrimitiveClauseNo" ref="a8" args="([in]long lPrClauseNo,[out, retval]long *lClauseNo)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::ClauseNoByPrimitiveClauseNo           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>lPrClauseNo</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] long *&nbsp;</td>
          <td class="mdname" nowrap> <em>lClauseNo</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
returns clause index by a primitive clause index     </td>
  </tr>
</table>
<a class="anchor" name="a4"></a><!-- doxytag: member="ISentence::ClausesCount" ref="a4" args="([out, retval] long *pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::ClausesCount           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[out, retval] long *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>pVal</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
the number of all clauses in the sentence     </td>
  </tr>
</table>
<a class="anchor" name="a6"></a><!-- doxytag: member="ISentence::CreateRelationsIterator" ref="a6" args="([out, retval] IRelationsIterator **piRelsIt)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::CreateRelationsIterator           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[out, retval] <a class="el" href="interfaceIRelationsIterator.html">IRelationsIterator</a> **&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>piRelsIt</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
returns a pointer to <a class="el" href="interfaceIRelationsIterator.html">IRelationsIterator</a>, which contains a dependency forest for this sentence     </td>
  </tr>
</table>
<a class="anchor" name="a7"></a><!-- doxytag: member="ISentence::GetHomonymByClauseVar" ref="a7" args="([in]long iWord,[in]long iVar,[in]long iClause,[out, retval]IHomonym **piHom)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::GetHomonymByClauseVar           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>iWord</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>iVar</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>iClause</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] <a class="el" href="classIHomonym.html">IHomonym</a> **&nbsp;</td>
          <td class="mdname" nowrap> <em>piHom</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
returns homonym by a clause variant     </td>
  </tr>
</table>
<a class="anchor" name="a10"></a><!-- doxytag: member="ISentence::GetOborotStrByOborotId" ref="a10" args="([in] long OborotId,[out, retval] BSTR *pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::GetOborotStrByOborotId           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>OborotId</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] BSTR *&nbsp;</td>
          <td class="mdname" nowrap> <em>pVal</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
returns a string representation of an oborot by an ID     </td>
  </tr>
</table>
<a class="anchor" name="a1"></a><!-- doxytag: member="ISentence::PrimitiveClause" ref="a1" args="([in] long lClauseNum,[out, retval] IClause **pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::PrimitiveClause           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>lClauseNum</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] <a class="el" href="classIClause.html">IClause</a> **&nbsp;</td>
          <td class="mdname" nowrap> <em>pVal</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
a primitive clause by an index     </td>
  </tr>
</table>
<a class="anchor" name="a9"></a><!-- doxytag: member="ISentence::PrimitiveClauseNoByClauseNo" ref="a9" args="([in]long lClauseNo,[out, retval]long *lPrClauseNo)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::PrimitiveClauseNoByClauseNo           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>lClauseNo</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] long *&nbsp;</td>
          <td class="mdname" nowrap> <em>lPrClauseNo</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
returns the primitive clause index by the clause index, if it is possible     </td>
  </tr>
</table>
<a class="anchor" name="a0"></a><!-- doxytag: member="ISentence::PrimitiveClausesCount" ref="a0" args="([out, retval] long *pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::PrimitiveClausesCount           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[out, retval] long *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>pVal</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
the number of all primitive clauses     </td>
  </tr>
</table>
<a class="anchor" name="a3"></a><!-- doxytag: member="ISentence::Word" ref="a3" args="([in] long lWordNum,[out, retval] IWord **pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::Word           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[in] long&nbsp;</td>
          <td class="mdname" nowrap> <em>lWordNum</em>, </td>
        </tr>
        <tr>
          <td class="md" nowrap align="right"></td>
          <td class="md"></td>
          <td class="md" nowrap>[out, retval] <a class="el" href="classIWord.html">IWord</a> **&nbsp;</td>
          <td class="mdname" nowrap> <em>pVal</em></td>
        </tr>
        <tr>
          <td class="md"></td>
          <td class="md">)&nbsp;</td>
          <td class="md" colspan="2"></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
a word by an index     </td>
  </tr>
</table>
<a class="anchor" name="a2"></a><!-- doxytag: member="ISentence::WordsNum" ref="a2" args="([out, retval] long *pVal)" --><p>
<table class="mdTable" cellpadding="2" cellspacing="0">
  <tr>
    <td class="mdRow">
      <table cellpadding="0" cellspacing="0" border="0">
        <tr>
          <td class="md" nowrap valign="top">HRESULT ISentence::WordsNum           </td>
          <td class="md" valign="top">(&nbsp;</td>
          <td class="md" nowrap valign="top">[out, retval] long *&nbsp;</td>
          <td class="mdname1" valign="top" nowrap> <em>pVal</em>          </td>
          <td class="md" valign="top">&nbsp;)&nbsp;</td>
          <td class="md" nowrap></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
<table cellspacing="5" cellpadding="0" border="0">
  <tr>
    <td>
      &nbsp;
    </td>
    <td>

<p>
the number of words in the sentence     </td>
  </tr>
</table>
<hr>The documentation for this interface was generated from the following file:<ul>
<li><a class="el" href="SynAn_8idl-source.html">SynAn.idl</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Feb 7 15:38:49 2006 for Synan by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.4 </small></address>
</body>
</html>
